home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / internet / irc_i_dodatki / phoenix / phoenix.doc < prev    next >
Text File  |  1996-11-27  |  20KB  |  411 lines
  1.                      \|/                            \|/
  2.  ---------------------| Welcome to Phoenix for AmIRC |---------------------
  3.                      /|\                            /|\
  4.               $VER: Phoenix.doc 1.17 (27.11.96) by |Paladin|
  5.  
  6.   This package is based upon Phoenix v2.27++ (for unix ircII) and works
  7.   best with AmIRC v1.11.  While it can be use with earlier versions,
  8.   internal changes in AmIRC will make some functions unusable.
  9.  
  10.   You can get the current version of this package from me ("|Paladin|" on
  11.   Undernet) or via email to nidalap@cris.com.  You may add yourself to the
  12.   Phoenix mailing-list by emailing me with subject "Phoenix-list" and
  13.   message body "ADD".  I only guarantee that a version directly from me is
  14.   free of intentional backdoors.  I am not responsible for (mis)use or any
  15.   resulting damage.  Use at YOUR own risk.
  16.  
  17.   This product is Freeware (freely distributable, author retains copyright).
  18.  
  19.   Files included in this archive:
  20.  
  21.        bin/.phoenix.cfg          - Phoenix configuration file
  22.        bin/Default.AmIRCfg       - Replacement or incorporable AmIRC config
  23.        bin/lamer                 - Text converter used by /TALK
  24.        bin/Phoenix-AmIRC         - Run-script to start Phoenix and AmIRC
  25.        bin/Phoenix-AmIRC.info    - Icon for above
  26.        bin/sanamon               - Monitors IP packets used by /TRACE
  27.        bin/rexx/Galaxynet.map    - Galaxynet server list used by /SPLIT
  28.        bin/rexx/map.amirx        - Script to make other maps for /SPLIT
  29.        bin/rexx/Phoenix.amirx    - Phoenix interface
  30.        bin/rexx/Phoenix          - Main program
  31.        bin/rexx/Undernet.map     - Undernet server list used by /SPLIT
  32.        Libs/rexxplslib.library   - v1.33
  33.        MUI/MUIRexx               - v2.1b
  34.        MUI/Libs/MUI/Icon.mcc     - Required by MUIRexx
  35.        WBStartup/RPStart         - RexxPlus host
  36.        WBStartup/RPStart.info    - Icon for above
  37.        aminuts.lzx               - How Aminet admins ban ARexx
  38.        Install_Phoenix           - Installer script
  39.        Install_Phoenix.info      - Icon for above
  40.        Phoenix.doc               - ASCII documentation
  41.        Phoenix.doc.info          - Icon for above
  42.        Phoenix.guide             - AmigaGuide documentation
  43.        Phoenix.guide.info        - Icon for above
  44.        Phoenix.history           - Version changes
  45.  
  46.   REQUIREMENTS (not included):
  47.  
  48.   · AmigaOS v3.0+ (required by MUIRexx)
  49.   · AmIRC v1.1+ by Oliver Wagner (ftp.vapor.com:/support/amirc/)
  50.   · ARexx v1.15
  51.   · MagicUserInterface v3.0+ (with ARexx interface enabled)
  52.  
  53.   A1200 NOTE: Current versions have small chance of running on A1200.
  54.   If you are amoung those that instantly guru switch to version 1.12a
  55.   or wait for 2.0.
  56.  
  57.   INSTALLATION:
  58.  
  59.   1) Unarchive with the -a switch to preserve file attributes
  60.      (eg. lzx -a x Phx1_17 ram:).
  61.  
  62.   2a) Use the included Install_Phoenix script for automated installation.
  63.  
  64.   2b) If you'd rather manually install Phoenix:
  65.  
  66.     · Copy Default.AmIRCfg, .phoenix.cfg, lamer, Phoenix-AmIRC*
  67.       and sanamon to the same directory as AmIRC (or cut/paste to your
  68.       existing Default.AmIRCfg).  Sanamon & lamer may be placed anywhere
  69.       else in your command path instead.
  70.     · Copy Phoenix.amirx, Phoenix.rexx, map.amirx, and *.map to rexx/
  71.       in AmIRC's directory.
  72.     · Copy *.library to your Libs: directory.
  73.     · Copy MUIRexx to your MUI: directory.
  74.     · Copy Icon.mcc to your MUI:Libs/MUI/ directory.
  75.     · Copy RPStart* to your SYS:WBStartup/ directory.
  76.     · Copy *.doc*, *.guide*, and *.history to wherever you want.
  77.     · Edit paths in .phoenix.cfg, Phoenix-AmIRC, and Phoenix.amirx.
  78.  
  79.   3) Reboot so that the new program in WBStartup/ is activated.
  80.  
  81.   FEATURES:
  82.  
  83.   · Auto-Op Friends on Join
  84.   · Auto-BanKick Enemies on Join
  85.   · Auto-Send files(packs) from list
  86.   · Auto-Get or Resume offered files
  87.   · Auto-Send SOUND files
  88.   · Auto-Request new SOUNDs
  89.   · Auto-Join on Invite from All or Friends
  90.   · Auto time display
  91.   · Channel Cycling
  92.   · Channel Configuration database
  93.   · DCC Limit
  94.   · Flood protection
  95.   · User login tracking (!SEEN <nick>)
  96.   · Raw packet tracing (non-IRC flood tracing)
  97.   · Protect Friends from DeOp/Ban
  98.   · Protect Channel from Flooding/Mass-Modes/Net-Split Hacking/Screw-Bans
  99.   · Protect/Enforce Channel Modes
  100.   · Prevent Chain-Opping
  101.   · Requested Op/Invite/UnBan/Anon-Kick commands for Friends
  102.   · Revenge Kick on DeOp/Ban/Kick of Friends
  103.   · Saves messages while Away
  104.   · Security
  105.   · Text/Command redirection to Channel/Nick
  106.   · Variable local feedback
  107.   · Phoenix 2.27++ compatible command syntax
  108.   · GUI option for many commands
  109.   · Flags for defining operation of each feature
  110.   · Mass/Channel-wide Ban/UnBan/Op/Deop/Msg/Notice/CTCP
  111.   · Random Nick
  112.   · Random I-Nick
  113.   · War Mode - BKick on DeOp/Ban/Kick of Friends/self
  114.   · Favorite channel list
  115.   · Country code lookup
  116.   · Split server finder
  117.  
  118.   =========================================================================
  119.                               CONFIGURATION FILE
  120.   =========================================================================
  121.  
  122.   Keyword      Valid Value   Description
  123.   -----------  -----------  -----------------------------------------------
  124.    autop        0/1          Auto-op OP-Friends when they join channel.
  125.    autobk       0/1          Auto-BK Enemies when they join channel.
  126.    autoc        0/1          Enable extended CTCP Friend commands
  127.                                (OP/INVITE/UNBAN/KICK).
  128.    autom        0/1          Autoget uses MOVE instead of GET.
  129.    bgops        0/1          Gain Ops on empty/split channel.
  130.    bmode        0/1          Enforce config'd channel modes.
  131.    bseen        0/1          Enable "!SEEN" processing.
  132.    cprot        0/1          Channel flood/mass-mode protection.
  133.    chain        0/1          Disallow chain-opping
  134.                                (only Friends can give out ops on channel).
  135.    delop        0/1          Delayed Auto-Op.
  136.    floodp       0/1          Flood protection.
  137.    nhp          0/1          Net-split hack protection.
  138.    noscrew      0/1          Undo screw-type bans placed in channel.
  139.    reqsnd       0/1          Auto-Request new SOUNDs via !nick <snd>.
  140.    revenge      0/1          Kick those that ban/kick/deop you or
  141.                                PROT-Friend.
  142.    sic          0/1          Show INVITE-able channels to INVITE-Friends.
  143.    war          0/1          Ban those that ban/kick/deop you, PROT-Friends,
  144.                                or try to unban someone on your Enemy list
  145.                                (war-mode forces revenge ON & autoget OFF,
  146.                                and ignores all incoming CTCPs).
  147.    xdcc         0/1          Enable auto-send (XDCC cmds) from file list.
  148.    xkick        0/1          Kick those trying to access your XDCC cmds
  149.                                that don't meet the current SEC requirement.
  150.    xsnd         0/1          Enable auto-send (!yournick <snd>) SOUNDs.
  151.    autoj        0/1/2        Auto-join channel as soon as you are invited;
  152.                                0 - Never,
  153.                                1 - Always,
  154.                                2 - Only from INVITE-Friends.
  155.    autoget      0/1/2        Auto accept incoming file offers;
  156.                                0 - Disable autoget,
  157.                                1 - Accept *all* offers,
  158.                                2 - XDCC-Friends only.
  159.    friendp      0/1/2        Protect PROT-Friends from ban/de-op;
  160.                                0 - No protection,
  161.                                1 - Protect,
  162.                                2 - Protect but no revenge against other
  163.                                    PROT-Friend.
  164.    sec          0/1/2        XDCC (autosend) access;
  165.                                0 - No security,
  166.                                1 - XDCC-Friends only,
  167.                                2 - Channel-Ops & XDCC-Friends only.
  168.    verb         0/1/2        Phoenix feedback verbosity;
  169.                                0 - Off/Quiet,
  170.                                1 - Low,
  171.                                2 - High.
  172.    bkey         <char>       Attention key for bot-like functions.
  173.    btype        'N'/'S'      Type of Ban-mask to use;
  174.                                'N' - Normal (ie. *!*name@*.domain.org),
  175.                                'S' - Screw (ie. *!*n?m?@*.do?a??n.?r?).
  176.    xlimit       <any #>      Maximum number of Autoget/send xfers at once.
  177.    reset        <any #>      Seconds before Flood Protection resets.
  178.    igtime       <any #>      Minutes to Ignore a flooder.
  179.    sens.PRIVMSG <any #>      Number of Message it takes to trip FloodP.
  180.    sens.NOTICE  <any #>      Number of Notices "    "   "   "     "   .
  181.    sens.CTCP    <any #>      Number of CTCPs   "    "   "   "     "   .
  182.    sens.DEOP    <any #>      Number of DeOps   "    "   "   "   CProt.
  183.    sens.KICK    <any #>      Number of Kicks   "    "   "   "     "  .
  184.    phxdir       <path>       Full path where Phoenix data file are
  185.                                to be accessed (eg. "inet:bin/").
  186.    alist        <filename>   File to save Away messages
  187.                                (eg. ".phoenix.away").
  188.    elist        <filename>   Name of Enemy list (eg. ".phoenix.enemy").
  189.    flist        <filename>   Name of Friend list (eg. ".phoenix.friend").
  190.    slist        <filename>   Name of last Seen list (eg. ".phoenix.seen").
  191.    xlist        <filename>   Name of Offer list (eg. ".phoenix.xdcc").
  192.    autobkmsg    <string>     Auto-BK Enemy message (eg. "| Auto BKick |").
  193.    cfmsg        <string>     Channel Flood kick message (eg. "| Flood |").
  194.    flmsg        <string>     Flood Protection triggered message
  195.                                (eg. "You have triggered my Flood
  196.                                Protection!  Ignoring you.").
  197.    frimsg       <string>     Revenge-Kick for PROT-Friend message
  198.                                (eg. "| Don't mess with my friends! |").
  199.    reqkmsg      <string>     KICK-Friend Requested-kick message
  200.                                (eg. "| Requested |").
  201.    revmsg       <string>     Revenge-Kick message (eg. "| Re\/enge |").
  202.    wkmsg        <string>     Word-Kick message (eg. "| WordKick |").
  203.    xkmsg        <string>     XDCC-Kick message (eg. "| XDCC Kick |").
  204.  
  205.   =========================================================================
  206.                                  COMMANDS
  207.   =========================================================================
  208.  
  209.   This is not meant to be an introduction to IRC, its commands, or its
  210.   terminology.  Join one of the help channels (#amirc, #ircnewbies, etc)
  211.   if you are confused.
  212.  
  213.   USER COMMANDs:
  214.  
  215.   /J <chan/?> [chan] .. - Joins channel(s) (# is not needed, nor is keyword
  216.      for config'd channels),
  217.      /J ? - pops up a GUI list with your favorite channels.
  218.   /L - leave current channel.
  219.   /CYCLE [#channel] - Quickly leaves & rejoin channel.
  220.   /WI, /WW <nick> - Display WHOIS & WHOWAS info on <nick>.
  221.   /WII <nick> - Display whois info on <nick> and their idle time.
  222.      (If known, both above also show who last opped/deopped them.)
  223.   /SERV <server> - Switch to <server>.
  224.   /SB - Show all bans on current channel.
  225.   /EXEC <command> - Redirect output of CLI <command> to current channel.
  226.   /TYPE <filename> - Display a file to your current channel.
  227.   /TIME [nick] - get [nick]'s local time or display your local time.
  228.   /VER, /VERSION [nick] - get [nick]'s client version info or Phoenix version.
  229.   /P [nick/chan] - Ping <nick/chan>. /P - Pings your current server.
  230.   /PC - Ping current channel.
  231.   /AP - Ping yourself.
  232.   /DC <nick> - Send a DCC CHAT request to <nick>.
  233.   /SC - Show who is on your current channel.
  234.   /IG <nick> - Ignore everything from <nick>.
  235.   /NOIG <nick> - Unignores <nick>.
  236.   /SETAWAY - Sets you away with default reason. Logs all messages.
  237.   /AWAY <reason> - Sets you away with <reason>. Logs all messages.
  238.   /BACK, /SETBACK - Sets you back, & reports # of messages received.
  239.   /LMSG - Display away message(s).
  240.   /DMSG - Delete away message(s).
  241.   /STATUS - Display your current Phoenix configuration.
  242.   /MM <nicks> :<text> - sends <text> msg to all <nicks>.
  243.   /N <nicks> :<text> - sends <text> notice to all <nicks>.
  244.   /QUIT - normal quit (must use this or /SQUIT to cleanly quit Phoenix).
  245.   /SHUTDOWN [!] - quit Phoenix script (if still an Event it will be reloaded
  246.      automatically after next msg unless [!] is specified).
  247.  
  248.   CONFIGURATION COMMANDs:
  249.  
  250.   /CONFIG - Invoke the GUI configuration window.
  251.   /SAVE - Saves your current PhoEniX settings to the config file.
  252.   /RELOAD - Reload settings from your config file.
  253.   /SENS <PRIVMSG/NOTICE/CTCP/DEOP/KICK> [#] - Set # of msgtype required to
  254.      trigger flood protection.
  255.   /RESET [#] - Set flood timeout(seconds).
  256.   /IGTIME [#] - Set time(minutes) to ignore a flooder.
  257.   /FLOODP [ON/OFF] - Turns personal flood protection <ON/OFF>.
  258.   /FRIENDP [ON/OFF/CHECK] - Protect Friends from ban/deop.
  259.   /NHP [ON/OFF] - Turns netsplit hack protection <ON/OFF>.
  260.   /CPROT [ON/OFF] - Turns channel flood/bomb protection <ON/OFF>
  261.   /ENFORCE [ON/OFF] - Enforce config'd channel modes.
  262.   /REVENGE [ON/OFF] - Turns revenge kick <ON/OFF>
  263.   /WAR <ON/OFF> - Turns revenge bankick <ON/OFF> and ignores all incoming
  264.      CTCPs.
  265.   /VERB [OFF/LOW/HIGH] - Turns extended command feedback <OFF/LOW/HIGH>.
  266.   /AUTOJ [ON/OFF/FRIENDS] - Turns AutoJoin on INVITE <ON/OFF> or only from
  267.      <FRIENDS> with INVITE flag.
  268.   /AUTOP [ON/OFF] - Turns Auto-Op friends on JOIN <ON/OFF>.
  269.   /DELAYOP [ON/OFF] - Turns Auto-Op random delay <ON/OFF>.
  270.   /AUTOC [ON/OFF] - Turns CTCP OP, INVITE, KICK, and UNBAN <ON/OFF>.
  271.   /AUTOGET [OFF/ON/XDCC] - to switch Autogetting of files ON/OFF/XDCC.
  272.   /AUTOM [ON/OFF] - <ON> makes Autoget use MOVE instead of GET.
  273.   /CHAIN [ON/OFF] - Turns Chain-Op prevention <ON/OFF>.
  274.   /NOSCREW [ON/OFF] - Turns Screw-Ban prevention <ON/OFF>.
  275.   /REQSND [ON/OFF] - to turn auto-requesting of new SOUNDs ON or OFF.
  276.   /SIC [ON/OFF] - to turn display of INVITE-able channels <ON/OFF>.
  277.   /SEEN [ON/OFF] - Enable !SEEN <nick> processing.
  278.   /XSND [ON/OFF] - to turn SOUND server ON or OFF.
  279.   /XDCC [ON/OFF] - to turn XDCC file server ON or OFF.
  280.   /STATUS - Display your current Phoenix configuration.
  281.  
  282.   LIST COMMANDs:
  283.  
  284.   /ADDF <nick/mask/-GUI> [flags].  Privilege flags you may assign include:
  285.      INVITE, OP, KICK, PROT, UNBAN, and XDCC.  HELP is assumed.
  286.      (To give them all available access, type /ADDF <nick> ALL)
  287.   /LISTF - Lists everyone on your Friends list and access levels.
  288.   /REMF <nick/mask/ALL/-GUI> - Removes <nick/mask> from the Friends list.
  289.   /ADDBK <nick/mask> - Adds <nick> or <mask> to your Enemy list.
  290.   /REMBK <nick/mask/ALL> - Removes <nick/mask> from your Enemy list.
  291.   /LISTBK - Lists your complete Enemy list.
  292.   /ADDC <chan> [modes] - Adds channel to your configuration.
  293.   /LISTC - Lists your configured channels.
  294.   /REMC <chan> [chan] .. - Removes channels from your configuration.
  295.   /XL - Does a /CTCP <Current Channel> XDCC LIST to see files offered.
  296.  
  297.   EXTRA COMMANDs:
  298.  
  299.   /ASKHOST <address> - Perform DNS lookup on <address>.
  300.   /COUNTRY <domain> - Display country name from abreviated extension.
  301.   /SOUND [nick/#channel] <sound/?> - Sends SOUND-play to [nick] (defaults
  302.      to current channel), '?' lets you select from a requestor.
  303.   /SPLIT [-] - Find split servers and display to current channel or just
  304.      to yourself [-].  If you don't have a server map for the net you use,
  305.      you will have to create one with the included map.amirx and rename it
  306.     (Undernet = "Undernet.map", Dalnet = "Dalnet.map", Galaxynet =
  307.     "Galaxynet.map", Arcnet = "Arcnet.map", efnet = "efnet.map").
  308.   /TALK <text> - converts <text> to LamerTalk and sends to channel.
  309.   /TRACE [[address] [secs]] - Trace packets from all or from [address].
  310.      Default of 30 secs may be changed with the [secs] option.
  311.   /WORDKICK <word> [word2] [word3] ... - Kick anyone that says a word in
  312.      your wordkick list from the channel they said it in.
  313.   /REMWORD <word/ALL> [word2] [word3] ... - Remove word(s) from your
  314.      WordKick list.  ALL clears your WordKick list.
  315.   /INICK - Changes your nick to random string of Il|][ characters.
  316.   /RNICK - Changes your nick to random ASCII string.
  317.   /MYNICK - return to your original (pre-INick/RNick) nick.
  318.   /SQUIT - fakes a server split as you quit.
  319.   /BREAK <process ID> - Sends Ctrl-C to external process #.
  320.   /VER - Shows complete Phoenix version string.
  321.  
  322.   OP COMMANDs:
  323.  
  324.   /C <mode(s)> - Sets <mode(s)> on current channel.
  325.   /INV, /I <nick> [nick2 nick3] - Invite <nick(s)> to your current channel.
  326.   /K <nick> [reason] - Kicks <nick> of current channel for <reason>.
  327.   /BK <nick> [reason] - Deops, bans, & kicks <nick>.
  328.   /T <topic> - Changes topic to <topic>. /T - Shows topic author.
  329.   /DEOP <nicks>|ALL|ALLBUT <nicks> - Deops <nicks> on current channel.
  330.      ALL deops everyone but yourself,
  331.      ALLBUT deops everyone but yourself and listed <nicks>.
  332.   /OP <nicks>|ALL|ALLBUT <nicks> - Ops <nicks> on current channel.
  333.      ALL ops everyone,
  334.      ALLBUT ops everyone but listed <nicks>.
  335.  
  336.   BAN COMMANDs:
  337.  
  338.   /BAN <nick(s)/mask(s)/ALL> - Ban any number of <nicks/masks> on your
  339.      current channel.  Each <nick> converted to current BanType mask.
  340.      (Use /BTYPE to change default bantype.)
  341.      /BAN ALL - bans everyone but yourself.
  342.   /BTYPE <N,S> - Sets ban type to normal or screw.
  343.      Used for AUTOBK, WAR, & /BAN.
  344.      N (Normal) *!*user@*.domain.org
  345.      S (Screw)  *!*u??r@*.d??a?n.?rg  [randomized]
  346.      (IP Addresses (Numerical) will be detected and banned correctly.)
  347.   /UNBAN <nick|mask> [nick|mask] ... - Undo ban(s) on the current channel.
  348.      /UNBAN <nick> - Unbans <nick> on your current channel.
  349.      /UNBAN <mask> - Reverses all bans matching <mask> on your channel.
  350.   /WAR <ON/OFF> - Turns revenge bankick <ON/OFF> and ignores all incoming
  351.      CTCPs.
  352.  
  353.   XDCC COMMANDs (file related):
  354.  
  355.   /REQSND [ON/OFF] - to turn auto-requesting of new SOUNDs ON or OFF.
  356.   /XSND [ON/OFF] - to turn SOUND server ON or OFF.
  357.   /XDCC [ON/OFF] - to turn XDCC file server ON or OFF.
  358.   /XDCC LIST <#> - to get a list of your offered packs.
  359.   /XDCC SEC <ON/OFF/OPS> - Turns XDCC Security ON, OFF or OPS only.
  360.   /XDCC NOTICE [#channel/nick] - to make a public notice that you are
  361.      offering files.
  362.   /XDCC PLIST [#channel/nick] - display your file list to the a channel
  363.      or <nick>.  (default is current channel)
  364.   /XDCC SEND - to send files.
  365.   /XDCC PSEND - to send packs.
  366.   /XDCC GET - to get files.
  367.   /XDCC STATUS - to get XDCC status.
  368.   /XDCC OFFER - to offer files to people.
  369.   /XDCC DOFFER <#n|*> - remove pack #n from offered list or all packs(*).
  370.   /XDCC AUTOGET [ON/OFF/XDCC] - to switch Autogetting of offered files
  371.      ON/OFF/XDCC.
  372.   /XDCC KICK [ON/OFF] - to switch Autokick of unregistered XDCC requests
  373.      ON/OFF.
  374.   /XDCC LIMIT <num> - to set your XDCC AUTOSEND limit.
  375.  
  376.   REMOTE CTCP COMMANDs:  (/CTCP <nick> <command>)
  377.  
  378.   HELP - List commands available to that user.
  379.   INVITE <#channel> - Send invite to user for <#channel>.
  380.   KICK <#channel> <nick> - KICK <nick> from <#channel>.
  381.   OP <#channel> - Give channel operator status to user on <#channel>.
  382.   UNBAN <#channel> - Remove ban on user from <#channel>.
  383.  
  384.   PUBLIC MSG COMMANDs:
  385.  
  386.   !<yournick> <sound> - AutoSend Sound to user if it exists (only if
  387.      /XSND is ON).
  388.   !SEEN <nick> - Checks for & displays when you last saw <nick>.
  389.  
  390.   =========================================================================
  391.                                   THANKS
  392.   =========================================================================
  393.  
  394.        Oliver Wagner - for AmIRC.
  395.  
  396.        Jay Weber - for Exec.amirx, Type.amirx, AmigaGuide docs help,
  397.         feedback & alpha testing.
  398.  
  399.        Russ Leighton - for MUIRexx.
  400.  
  401.        Walter Productions - for split.cb.
  402.  
  403.        Troy Davis - for Away.amirx
  404.  
  405.        Many others - for beta testing.
  406.  
  407.        ASDG - for CynusEd.
  408.  
  409.        Various users - for emailing useful bug reports.
  410.                                                                       ©1996
  411.